﻿/**
 * Copyright (C) 2004-2009 D3Systems, Inc. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA 
 */
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using agsXMPP;
using agsXMPP.protocol.client;

namespace OMGGateways
{
    /// <summary>
    /// Interface that must be implemented by all 3rd Party Gateway Implementations
    /// </summary>
    interface GWInterface
    {
        /// <summary>
        /// Initializes the Gateway Interface
        /// </summary>
        /// <param name="loginDetails">The Login Detail that will be used by this Gateway Interface</param>
        /// <param name="logger">For Debugging Purposes</param>
        void Init(LoginDetails loginDetails, System.Diagnostics.EventLog logger);

        /// <summary>
        /// Sets the LoginDetails to be used by this Gateway Interface
        /// </summary>
        /// <param name="loginDetails">The Login Detail that will be used by this Gateway Interface</param>
        void SetLoginDetails(LoginDetails loginDetails);

        /// <summary>
        /// Implements Login Method
        /// </summary>
        void Login();

        /// <summary>
        /// Implements the Sending of Message Packets
        /// </summary>
        /// <param name="toJid"></param>
        /// <param name="type"></param>
        /// <param name="body"></param>
        void SendMessage(Jid toJid, MessageType type, String body);

        /// <summary>
        /// Implements the Sending of Presence packets
        /// </summary>
        /// <param name="type"></param>
        /// <param name="status"></param>
        void SendPresence(ShowType type, String status);
    }
}
